<HTML>
<BODY BGCOLOR="white">
<PRE>
<FONT color="green">001</FONT>    package edu.hawaii.csdl.simplejcs;<a name="line.1"></a>
<FONT color="green">002</FONT>    <a name="line.2"></a>
<FONT color="green">003</FONT>    import java.io.BufferedWriter;<a name="line.3"></a>
<FONT color="green">004</FONT>    import java.io.File;<a name="line.4"></a>
<FONT color="green">005</FONT>    import java.io.FileWriter;<a name="line.5"></a>
<FONT color="green">006</FONT>    import java.io.Serializable;<a name="line.6"></a>
<FONT color="green">007</FONT>    import java.util.ArrayList;<a name="line.7"></a>
<FONT color="green">008</FONT>    import java.util.Date;<a name="line.8"></a>
<FONT color="green">009</FONT>    import java.util.HashSet;<a name="line.9"></a>
<FONT color="green">010</FONT>    import java.util.List;<a name="line.10"></a>
<FONT color="green">011</FONT>    import java.util.Map;<a name="line.11"></a>
<FONT color="green">012</FONT>    import java.util.Properties;<a name="line.12"></a>
<FONT color="green">013</FONT>    import java.util.Set;<a name="line.13"></a>
<FONT color="green">014</FONT>    import java.util.TreeMap;<a name="line.14"></a>
<FONT color="green">015</FONT>    import java.util.logging.Level;<a name="line.15"></a>
<FONT color="green">016</FONT>    import java.util.logging.Logger;<a name="line.16"></a>
<FONT color="green">017</FONT>    <a name="line.17"></a>
<FONT color="green">018</FONT>    import org.apache.jcs.access.exception.CacheException;<a name="line.18"></a>
<FONT color="green">019</FONT>    import org.apache.jcs.engine.ElementAttributes;<a name="line.19"></a>
<FONT color="green">020</FONT>    import org.apache.jcs.engine.control.CompositeCacheManager;<a name="line.20"></a>
<FONT color="green">021</FONT>    import org.apache.jcs.JCS;<a name="line.21"></a>
<FONT color="green">022</FONT>    <a name="line.22"></a>
<FONT color="green">023</FONT>    /**<a name="line.23"></a>
<FONT color="green">024</FONT>     * Provides a wrapper around Apache JCS (Java Caching System) to facilitate a "common case" <a name="line.24"></a>
<FONT color="green">025</FONT>     * for caching. This wrapper provides the following:<a name="line.25"></a>
<FONT color="green">026</FONT>     * &lt;ul&gt;<a name="line.26"></a>
<FONT color="green">027</FONT>     * &lt;li&gt; Typed interface, such as SimpleJcs&amp;lt;String, String&amp;gt;. <a name="line.27"></a>
<FONT color="green">028</FONT>     * &lt;li&gt; Automatic configuration of an indexed disk cache backing store.<a name="line.28"></a>
<FONT color="green">029</FONT>     * &lt;li&gt; Write-through caching: All cached instances are written out to disk. <a name="line.29"></a>
<FONT color="green">030</FONT>     * &lt;li&gt; Provides a default maximum life for entries of 365 days.<a name="line.30"></a>
<FONT color="green">031</FONT>     * &lt;li&gt; Provides a default maximum cache size of 100,000 instances.<a name="line.31"></a>
<FONT color="green">032</FONT>     * &lt;li&gt; Provides a default directory location (~/.simplejcs) for cache files. <a name="line.32"></a>
<FONT color="green">033</FONT>     * &lt;li&gt; Ensures that all SimpleJcs instances have a unique name.<a name="line.33"></a>
<FONT color="green">034</FONT>     * &lt;li&gt; All caches use the JCS "group" facility to allow access to the set of keys. <a name="line.34"></a>
<FONT color="green">035</FONT>     * &lt;li&gt; Constructor uses "days" rather than seconds as time unit for maxLife.<a name="line.35"></a>
<FONT color="green">036</FONT>     * &lt;li&gt; put() uses "hours" rather than seconds as time unit for maxLife.<a name="line.36"></a>
<FONT color="green">037</FONT>     * &lt;li&gt; A more convenient API for setting/getting items from the cache and controlling logging.<a name="line.37"></a>
<FONT color="green">038</FONT>     * &lt;li&gt; Logging of exceptions raised by JCS (if a logger is supplied).<a name="line.38"></a>
<FONT color="green">039</FONT>     * &lt;li&gt; Disables JCS logging messages unless the System property SimpleJcs.enableJCSLogging is set.<a name="line.39"></a>
<FONT color="green">040</FONT>     * &lt;li&gt; Shutdown hook ensures that backing index file is closed correctly on JVM exit. <a name="line.40"></a>
<FONT color="green">041</FONT>     * &lt;li&gt; Convenient packaging mechanism for required jar files to simplify library use.<a name="line.41"></a>
<FONT color="green">042</FONT>     * &lt;/ul&gt;<a name="line.42"></a>
<FONT color="green">043</FONT>     * <a name="line.43"></a>
<FONT color="green">044</FONT>     * @param &lt;K&gt; The type of the cache key.<a name="line.44"></a>
<FONT color="green">045</FONT>     * @param &lt;V&gt; The type of the cache value. <a name="line.45"></a>
<FONT color="green">046</FONT>     * <a name="line.46"></a>
<FONT color="green">047</FONT>     * @author Philip Johnson<a name="line.47"></a>
<FONT color="green">048</FONT>     */<a name="line.48"></a>
<FONT color="green">049</FONT>    public class SimpleJcs&lt;K extends Serializable, V extends Serializable&gt; {<a name="line.49"></a>
<FONT color="green">050</FONT>      <a name="line.50"></a>
<FONT color="green">051</FONT>      /** The number of seconds in a day. * */<a name="line.51"></a>
<FONT color="green">052</FONT>      private static final long secondsInADay = 60L * 60L * 24L;<a name="line.52"></a>
<FONT color="green">053</FONT>      /** Default number of days for max life. */<a name="line.53"></a>
<FONT color="green">054</FONT>      private static final Long defaultMaxLifeDays = 365L; <a name="line.54"></a>
<FONT color="green">055</FONT>      /** Maximum number of in-memory instances before sending items to disk. Default is 50,000. */<a name="line.55"></a>
<FONT color="green">056</FONT>      private static final Long defaultCapacity = 100000L;<a name="line.56"></a>
<FONT color="green">057</FONT>      /** The name of this cache, which defines a "region" in JCS terms. */<a name="line.57"></a>
<FONT color="green">058</FONT>      private String cacheName = null;<a name="line.58"></a>
<FONT color="green">059</FONT>      /** The logger used for cache exception logging. */<a name="line.59"></a>
<FONT color="green">060</FONT>      private Logger logger = null;<a name="line.60"></a>
<FONT color="green">061</FONT>      /** Holds a list of already defined caches to help ensure uniqueness. */<a name="line.61"></a>
<FONT color="green">062</FONT>      private static List&lt;String&gt; cacheNames = new ArrayList&lt;String&gt;();<a name="line.62"></a>
<FONT color="green">063</FONT>      /** Default group name. No client should ever using the following string for a group. */<a name="line.63"></a>
<FONT color="green">064</FONT>      private static final String DEFAULT_GROUP = "__Default_SimpleJcs_Group__";<a name="line.64"></a>
<FONT color="green">065</FONT>      <a name="line.65"></a>
<FONT color="green">066</FONT>      private static final String failureMsg = "Failure to clear cache ";<a name="line.66"></a>
<FONT color="green">067</FONT>      <a name="line.67"></a>
<FONT color="green">068</FONT>      /** Default directory where cache files go: ~/.simplejcs. **/<a name="line.68"></a>
<FONT color="green">069</FONT>      private static final String defaultDir = System.getProperty("user.home") + "/.simplejcs";<a name="line.69"></a>
<FONT color="green">070</FONT>      <a name="line.70"></a>
<FONT color="green">071</FONT>      /** A thread that will ensure that all of these caches will be disposed of during shutdown. */ <a name="line.71"></a>
<FONT color="green">072</FONT>      private static Thread shutdownThread = new Thread() {<a name="line.72"></a>
<FONT color="green">073</FONT>        /** Run the shutdown hook for disposing of all caches. */<a name="line.73"></a>
<FONT color="green">074</FONT>        @Override <a name="line.74"></a>
<FONT color="green">075</FONT>        public void run() {<a name="line.75"></a>
<FONT color="green">076</FONT>          for (String cacheName : cacheNames) {<a name="line.76"></a>
<FONT color="green">077</FONT>            try {<a name="line.77"></a>
<FONT color="green">078</FONT>              System.out.println("Shutting down " + cacheName + " cache.");<a name="line.78"></a>
<FONT color="green">079</FONT>              JCS.getInstance(cacheName).dispose();<a name="line.79"></a>
<FONT color="green">080</FONT>            }<a name="line.80"></a>
<FONT color="green">081</FONT>            catch (Exception e) {<a name="line.81"></a>
<FONT color="green">082</FONT>              String msg = failureMsg + cacheName + ":" + e.getMessage();<a name="line.82"></a>
<FONT color="green">083</FONT>              System.out.println(msg);<a name="line.83"></a>
<FONT color="green">084</FONT>            }<a name="line.84"></a>
<FONT color="green">085</FONT>          }<a name="line.85"></a>
<FONT color="green">086</FONT>        }<a name="line.86"></a>
<FONT color="green">087</FONT>      };<a name="line.87"></a>
<FONT color="green">088</FONT>      <a name="line.88"></a>
<FONT color="green">089</FONT>      /** A boolean that enables us to figure out whether to install the shutdown thread.  */<a name="line.89"></a>
<FONT color="green">090</FONT>      private static boolean hasShutdownHook = false;  //NOPMD<a name="line.90"></a>
<FONT color="green">091</FONT>      <a name="line.91"></a>
<FONT color="green">092</FONT>      /**<a name="line.92"></a>
<FONT color="green">093</FONT>       * Creates a new SimpleJcs instance with the specified name.  <a name="line.93"></a>
<FONT color="green">094</FONT>       * Defaults used for backing store directory, max life, and capacity.<a name="line.94"></a>
<FONT color="green">095</FONT>       *  <a name="line.95"></a>
<FONT color="green">096</FONT>       * @param cacheName The name of this cache.<a name="line.96"></a>
<FONT color="green">097</FONT>       */<a name="line.97"></a>
<FONT color="green">098</FONT>      public SimpleJcs(String cacheName) {<a name="line.98"></a>
<FONT color="green">099</FONT>        this(cacheName, defaultDir, defaultMaxLifeDays * secondsInADay, defaultCapacity, null);<a name="line.99"></a>
<FONT color="green">100</FONT>      }<a name="line.100"></a>
<FONT color="green">101</FONT>      <a name="line.101"></a>
<FONT color="green">102</FONT>      /**<a name="line.102"></a>
<FONT color="green">103</FONT>       * Creates a new SimpleJcs instance with the specified name in the specified directory.<a name="line.103"></a>
<FONT color="green">104</FONT>       * Defaults used for max life, and capacity.<a name="line.104"></a>
<FONT color="green">105</FONT>       * <a name="line.105"></a>
<FONT color="green">106</FONT>       * @param cacheName The name of this cache.<a name="line.106"></a>
<FONT color="green">107</FONT>       * @param dir The directory where the cache files are located. <a name="line.107"></a>
<FONT color="green">108</FONT>       */<a name="line.108"></a>
<FONT color="green">109</FONT>      public SimpleJcs(String cacheName, String dir) {<a name="line.109"></a>
<FONT color="green">110</FONT>        this(cacheName, dir, defaultMaxLifeDays * secondsInADay, defaultCapacity, null);<a name="line.110"></a>
<FONT color="green">111</FONT>      }<a name="line.111"></a>
<FONT color="green">112</FONT>      <a name="line.112"></a>
<FONT color="green">113</FONT>      /**<a name="line.113"></a>
<FONT color="green">114</FONT>       * Creates a new SimpleJcs with the specified parameters. <a name="line.114"></a>
<FONT color="green">115</FONT>       * If a cache with this name already exists, then this instance will be an alias to that cache<a name="line.115"></a>
<FONT color="green">116</FONT>       * and its original configuration will remain unchanged. <a name="line.116"></a>
<FONT color="green">117</FONT>       * <a name="line.117"></a>
<FONT color="green">118</FONT>       * @param cacheName The name of this SimpleJcs, which will be used as the JCS "region".<a name="line.118"></a>
<FONT color="green">119</FONT>       * @param dir the directory in which the backing store will be created.<a name="line.119"></a>
<FONT color="green">120</FONT>       * @param maxLifeSeconds The maximum number of SECONDS after which items expire from the cache.<a name="line.120"></a>
<FONT color="green">121</FONT>       * @param capacity The maximum number of instances to hold in the cache.<a name="line.121"></a>
<FONT color="green">122</FONT>       * @param logger The user-supplied logger, if logging of errors is desired. Null if no logging.  <a name="line.122"></a>
<FONT color="green">123</FONT>       */<a name="line.123"></a>
<FONT color="green">124</FONT>      public SimpleJcs(String cacheName, String dir, Long maxLifeSeconds, Long capacity, <a name="line.124"></a>
<FONT color="green">125</FONT>          Logger logger) {<a name="line.125"></a>
<FONT color="green">126</FONT>        // Only one SimpleJcs can be created at a time so that we can enforce unique cache names. <a name="line.126"></a>
<FONT color="green">127</FONT>        synchronized (SimpleJcs.class) {<a name="line.127"></a>
<FONT color="green">128</FONT>          if (!SimpleJcs.hasShutdownHook) {<a name="line.128"></a>
<FONT color="green">129</FONT>            Runtime.getRuntime().addShutdownHook(SimpleJcs.shutdownThread);<a name="line.129"></a>
<FONT color="green">130</FONT>            SimpleJcs.hasShutdownHook = true;<a name="line.130"></a>
<FONT color="green">131</FONT>          }<a name="line.131"></a>
<FONT color="green">132</FONT>          this.cacheName = cacheName;<a name="line.132"></a>
<FONT color="green">133</FONT>          this.logger = logger;<a name="line.133"></a>
<FONT color="green">134</FONT>          mkdirs(dir);<a name="line.134"></a>
<FONT color="green">135</FONT>    <a name="line.135"></a>
<FONT color="green">136</FONT>          // Finish configuration if this is a new instance of the cache.<a name="line.136"></a>
<FONT color="green">137</FONT>          if (!SimpleJcs.cacheNames.contains(cacheName)) {<a name="line.137"></a>
<FONT color="green">138</FONT>            SimpleJcs.cacheNames.add(cacheName);<a name="line.138"></a>
<FONT color="green">139</FONT>            if (!System.getProperties().containsKey("SimpleJcs.enableJCSLogging")) {<a name="line.139"></a>
<FONT color="green">140</FONT>              Logger.getLogger("org.apache.jcs").setLevel(Level.OFF);<a name="line.140"></a>
<FONT color="green">141</FONT>            }<a name="line.141"></a>
<FONT color="green">142</FONT>            CompositeCacheManager ccm = CompositeCacheManager.getUnconfiguredInstance();<a name="line.142"></a>
<FONT color="green">143</FONT>            ccm.configure(initJcsProps(cacheName, dir, maxLifeSeconds, capacity));<a name="line.143"></a>
<FONT color="green">144</FONT>          }<a name="line.144"></a>
<FONT color="green">145</FONT>        }<a name="line.145"></a>
<FONT color="green">146</FONT>      }<a name="line.146"></a>
<FONT color="green">147</FONT>      <a name="line.147"></a>
<FONT color="green">148</FONT>      /**<a name="line.148"></a>
<FONT color="green">149</FONT>       * Adds the key-value pair to this cache. Entry will expire from cache after the default maxLife.<a name="line.149"></a>
<FONT color="green">150</FONT>       * Logs a message if the cache throws an exception.<a name="line.150"></a>
<FONT color="green">151</FONT>       * <a name="line.151"></a>
<FONT color="green">152</FONT>       * @param key The key.<a name="line.152"></a>
<FONT color="green">153</FONT>       * @param value The value.<a name="line.153"></a>
<FONT color="green">154</FONT>       */<a name="line.154"></a>
<FONT color="green">155</FONT>      public void put(K key, V value) {<a name="line.155"></a>
<FONT color="green">156</FONT>        try {<a name="line.156"></a>
<FONT color="green">157</FONT>          JCS.getInstance(this.cacheName).putInGroup(key, DEFAULT_GROUP, value);<a name="line.157"></a>
<FONT color="green">158</FONT>        }<a name="line.158"></a>
<FONT color="green">159</FONT>        catch (CacheException e) {<a name="line.159"></a>
<FONT color="green">160</FONT>          String msg = "Failure to add " + key + " to cache " + this.cacheName + ":" + e.getMessage();<a name="line.160"></a>
<FONT color="green">161</FONT>          log(msg);<a name="line.161"></a>
<FONT color="green">162</FONT>        }<a name="line.162"></a>
<FONT color="green">163</FONT>      }<a name="line.163"></a>
<FONT color="green">164</FONT>      <a name="line.164"></a>
<FONT color="green">165</FONT>      /**<a name="line.165"></a>
<FONT color="green">166</FONT>       * Adds the key-value pair to this cache with an explicit expiration time.  <a name="line.166"></a>
<FONT color="green">167</FONT>       * <a name="line.167"></a>
<FONT color="green">168</FONT>       * @param key The key.<a name="line.168"></a>
<FONT color="green">169</FONT>       * @param value The value.<a name="line.169"></a>
<FONT color="green">170</FONT>       * @param maxLifeHours The number of hours before this item will expire from cache.<a name="line.170"></a>
<FONT color="green">171</FONT>       */<a name="line.171"></a>
<FONT color="green">172</FONT>      public void put(K key, V value, double maxLifeHours) {<a name="line.172"></a>
<FONT color="green">173</FONT>        try {<a name="line.173"></a>
<FONT color="green">174</FONT>          ElementAttributes attributes = new ElementAttributes();<a name="line.174"></a>
<FONT color="green">175</FONT>          long maxLifeSeconds = (long)(maxLifeHours * 3600D);<a name="line.175"></a>
<FONT color="green">176</FONT>          attributes.setMaxLifeSeconds(maxLifeSeconds);<a name="line.176"></a>
<FONT color="green">177</FONT>          attributes.setIsEternal(false);<a name="line.177"></a>
<FONT color="green">178</FONT>          JCS.getInstance(this.cacheName).putInGroup(key, DEFAULT_GROUP, value, attributes);<a name="line.178"></a>
<FONT color="green">179</FONT>        }<a name="line.179"></a>
<FONT color="green">180</FONT>        catch (CacheException e) {<a name="line.180"></a>
<FONT color="green">181</FONT>          String msg = "Failure to add " + key + " to cache " + this.cacheName + ":" + e.getMessage();<a name="line.181"></a>
<FONT color="green">182</FONT>          log(msg);<a name="line.182"></a>
<FONT color="green">183</FONT>        }<a name="line.183"></a>
<FONT color="green">184</FONT>      }<a name="line.184"></a>
<FONT color="green">185</FONT>      <a name="line.185"></a>
<FONT color="green">186</FONT>      /**<a name="line.186"></a>
<FONT color="green">187</FONT>       * Returns the object associated with key from the cache, or null if not found. <a name="line.187"></a>
<FONT color="green">188</FONT>       * <a name="line.188"></a>
<FONT color="green">189</FONT>       * @param key The key whose associated value is to be retrieved.<a name="line.189"></a>
<FONT color="green">190</FONT>       * @return The value, or null if not found.<a name="line.190"></a>
<FONT color="green">191</FONT>       */<a name="line.191"></a>
<FONT color="green">192</FONT>      @SuppressWarnings("unchecked")<a name="line.192"></a>
<FONT color="green">193</FONT>      public V get(K key) {<a name="line.193"></a>
<FONT color="green">194</FONT>        try {<a name="line.194"></a>
<FONT color="green">195</FONT>          return (V)JCS.getInstance(this.cacheName).getFromGroup(key, DEFAULT_GROUP);<a name="line.195"></a>
<FONT color="green">196</FONT>        }<a name="line.196"></a>
<FONT color="green">197</FONT>        catch (CacheException e) {<a name="line.197"></a>
<FONT color="green">198</FONT>          String msg = "Failure of get: " + key + " in cache " + this.cacheName + ":" + e.getMessage();<a name="line.198"></a>
<FONT color="green">199</FONT>          log(msg);<a name="line.199"></a>
<FONT color="green">200</FONT>          return null;<a name="line.200"></a>
<FONT color="green">201</FONT>        }<a name="line.201"></a>
<FONT color="green">202</FONT>      }<a name="line.202"></a>
<FONT color="green">203</FONT>    <a name="line.203"></a>
<FONT color="green">204</FONT>      /**<a name="line.204"></a>
<FONT color="green">205</FONT>       * Ensures that the key-value pair associated with key is no longer in this cache. <a name="line.205"></a>
<FONT color="green">206</FONT>       * Logs a message if the cache throws an exception.<a name="line.206"></a>
<FONT color="green">207</FONT>       * <a name="line.207"></a>
<FONT color="green">208</FONT>       * @param key The key to be removed.<a name="line.208"></a>
<FONT color="green">209</FONT>       */<a name="line.209"></a>
<FONT color="green">210</FONT>      public void remove(K key) {<a name="line.210"></a>
<FONT color="green">211</FONT>        try {<a name="line.211"></a>
<FONT color="green">212</FONT>          JCS.getInstance(this.cacheName).remove(key, DEFAULT_GROUP);<a name="line.212"></a>
<FONT color="green">213</FONT>        }<a name="line.213"></a>
<FONT color="green">214</FONT>        catch (CacheException e) {<a name="line.214"></a>
<FONT color="green">215</FONT>          String msg = "Failure to remove: " + key + " cache " + this.cacheName + ":" + e.getMessage();<a name="line.215"></a>
<FONT color="green">216</FONT>          log(msg);<a name="line.216"></a>
<FONT color="green">217</FONT>        }<a name="line.217"></a>
<FONT color="green">218</FONT>      }<a name="line.218"></a>
<FONT color="green">219</FONT>      <a name="line.219"></a>
<FONT color="green">220</FONT>      /**<a name="line.220"></a>
<FONT color="green">221</FONT>       * Removes everything in the default cache, but not any of the group caches. <a name="line.221"></a>
<FONT color="green">222</FONT>       */<a name="line.222"></a>
<FONT color="green">223</FONT>      public void clear() {<a name="line.223"></a>
<FONT color="green">224</FONT>        clearGroup(DEFAULT_GROUP);<a name="line.224"></a>
<FONT color="green">225</FONT>      }<a name="line.225"></a>
<FONT color="green">226</FONT>    <a name="line.226"></a>
<FONT color="green">227</FONT>      /**<a name="line.227"></a>
<FONT color="green">228</FONT>       * Clears the default as well as all group caches. <a name="line.228"></a>
<FONT color="green">229</FONT>       */<a name="line.229"></a>
<FONT color="green">230</FONT>      public void clearAll() {<a name="line.230"></a>
<FONT color="green">231</FONT>        try {<a name="line.231"></a>
<FONT color="green">232</FONT>          JCS.getInstance(this.cacheName).clear();<a name="line.232"></a>
<FONT color="green">233</FONT>        }<a name="line.233"></a>
<FONT color="green">234</FONT>        catch (CacheException e) {<a name="line.234"></a>
<FONT color="green">235</FONT>          String msg = failureMsg + this.cacheName + ":" + e.getMessage();<a name="line.235"></a>
<FONT color="green">236</FONT>          log(msg);<a name="line.236"></a>
<FONT color="green">237</FONT>        }<a name="line.237"></a>
<FONT color="green">238</FONT>      }<a name="line.238"></a>
<FONT color="green">239</FONT>    <a name="line.239"></a>
<FONT color="green">240</FONT>      /**<a name="line.240"></a>
<FONT color="green">241</FONT>       * Returns the set of keys associated with this cache. <a name="line.241"></a>
<FONT color="green">242</FONT>       * @return The set containing the keys for this cache. <a name="line.242"></a>
<FONT color="green">243</FONT>       */<a name="line.243"></a>
<FONT color="green">244</FONT>      public Set&lt;K&gt; getKeys() {<a name="line.244"></a>
<FONT color="green">245</FONT>        return getGroupKeys(DEFAULT_GROUP);<a name="line.245"></a>
<FONT color="green">246</FONT>      }<a name="line.246"></a>
<FONT color="green">247</FONT>      <a name="line.247"></a>
<FONT color="green">248</FONT>      /**<a name="line.248"></a>
<FONT color="green">249</FONT>       * Returns the current number of elements in this cache. <a name="line.249"></a>
<FONT color="green">250</FONT>       * @return The current size of this cache. <a name="line.250"></a>
<FONT color="green">251</FONT>       */<a name="line.251"></a>
<FONT color="green">252</FONT>      public int size() {<a name="line.252"></a>
<FONT color="green">253</FONT>        return getGroupSize(DEFAULT_GROUP);<a name="line.253"></a>
<FONT color="green">254</FONT>      }<a name="line.254"></a>
<FONT color="green">255</FONT>      <a name="line.255"></a>
<FONT color="green">256</FONT>      <a name="line.256"></a>
<FONT color="green">257</FONT>      /**<a name="line.257"></a>
<FONT color="green">258</FONT>       * Shuts down the specified cache, and removes it from the list of active caches so it can be<a name="line.258"></a>
<FONT color="green">259</FONT>       * created again.<a name="line.259"></a>
<FONT color="green">260</FONT>       * <a name="line.260"></a>
<FONT color="green">261</FONT>       * @param cacheName The name of the cache to dispose of.<a name="line.261"></a>
<FONT color="green">262</FONT>       */<a name="line.262"></a>
<FONT color="green">263</FONT>      public static void dispose(String cacheName) {<a name="line.263"></a>
<FONT color="green">264</FONT>        try {<a name="line.264"></a>
<FONT color="green">265</FONT>          cacheNames.remove(cacheName);<a name="line.265"></a>
<FONT color="green">266</FONT>          JCS.getInstance(cacheName).dispose();<a name="line.266"></a>
<FONT color="green">267</FONT>        }<a name="line.267"></a>
<FONT color="green">268</FONT>        catch (CacheException e) {<a name="line.268"></a>
<FONT color="green">269</FONT>          String msg = failureMsg + cacheName + ":" + e.getMessage();<a name="line.269"></a>
<FONT color="green">270</FONT>          System.out.println(msg);<a name="line.270"></a>
<FONT color="green">271</FONT>        }<a name="line.271"></a>
<FONT color="green">272</FONT>      }<a name="line.272"></a>
<FONT color="green">273</FONT>      <a name="line.273"></a>
<FONT color="green">274</FONT>      <a name="line.274"></a>
<FONT color="green">275</FONT>      /**<a name="line.275"></a>
<FONT color="green">276</FONT>       * Implements group-based addition of cache elements.<a name="line.276"></a>
<FONT color="green">277</FONT>       * @param key The key.<a name="line.277"></a>
<FONT color="green">278</FONT>       * @param group The group.<a name="line.278"></a>
<FONT color="green">279</FONT>       * @param value The value.<a name="line.279"></a>
<FONT color="green">280</FONT>       */<a name="line.280"></a>
<FONT color="green">281</FONT>      public void putInGroup(K key, String group, V value) {<a name="line.281"></a>
<FONT color="green">282</FONT>        try {<a name="line.282"></a>
<FONT color="green">283</FONT>          JCS.getInstance(this.cacheName).putInGroup(key, group, value);<a name="line.283"></a>
<FONT color="green">284</FONT>        }<a name="line.284"></a>
<FONT color="green">285</FONT>        catch (CacheException e) {<a name="line.285"></a>
<FONT color="green">286</FONT>          String msg = "Failure to add " + key + " to cache " + this.cacheName + ":" + e.getMessage();<a name="line.286"></a>
<FONT color="green">287</FONT>          log(msg);<a name="line.287"></a>
<FONT color="green">288</FONT>        }<a name="line.288"></a>
<FONT color="green">289</FONT>      }<a name="line.289"></a>
<FONT color="green">290</FONT>    <a name="line.290"></a>
<FONT color="green">291</FONT>      /**<a name="line.291"></a>
<FONT color="green">292</FONT>       * Implements group-based retrieval of cache elements. <a name="line.292"></a>
<FONT color="green">293</FONT>       * @param key The key.<a name="line.293"></a>
<FONT color="green">294</FONT>       * @param group The group.<a name="line.294"></a>
<FONT color="green">295</FONT>       * @return The element associated with key in the group, or null.<a name="line.295"></a>
<FONT color="green">296</FONT>       */<a name="line.296"></a>
<FONT color="green">297</FONT>      @SuppressWarnings("unchecked")<a name="line.297"></a>
<FONT color="green">298</FONT>      public V getFromGroup(K key, String group) {<a name="line.298"></a>
<FONT color="green">299</FONT>        try {<a name="line.299"></a>
<FONT color="green">300</FONT>          return (V)JCS.getInstance(this.cacheName).getFromGroup(key, group);<a name="line.300"></a>
<FONT color="green">301</FONT>        }<a name="line.301"></a>
<FONT color="green">302</FONT>        catch (CacheException e) {<a name="line.302"></a>
<FONT color="green">303</FONT>          String msg = "Failure of get: " + key + " in cache " + this.cacheName + ":" + e.getMessage();<a name="line.303"></a>
<FONT color="green">304</FONT>          log(msg);<a name="line.304"></a>
<FONT color="green">305</FONT>          return null;<a name="line.305"></a>
<FONT color="green">306</FONT>        }<a name="line.306"></a>
<FONT color="green">307</FONT>      }<a name="line.307"></a>
<FONT color="green">308</FONT>      <a name="line.308"></a>
<FONT color="green">309</FONT>      /**<a name="line.309"></a>
<FONT color="green">310</FONT>       * Implements group-based removal of cache elements. <a name="line.310"></a>
<FONT color="green">311</FONT>       * @param key The key whose value is to be removed. <a name="line.311"></a>
<FONT color="green">312</FONT>       * @param group The group.<a name="line.312"></a>
<FONT color="green">313</FONT>       */<a name="line.313"></a>
<FONT color="green">314</FONT>      public void removeFromGroup(K key, String group) {<a name="line.314"></a>
<FONT color="green">315</FONT>        try {<a name="line.315"></a>
<FONT color="green">316</FONT>          JCS.getInstance(this.cacheName).remove(key, group);<a name="line.316"></a>
<FONT color="green">317</FONT>        }<a name="line.317"></a>
<FONT color="green">318</FONT>        catch (CacheException e) {<a name="line.318"></a>
<FONT color="green">319</FONT>          String msg = "Failure to remove: " + key + " cache " + this.cacheName + ":" + e.getMessage();<a name="line.319"></a>
<FONT color="green">320</FONT>          log(msg);<a name="line.320"></a>
<FONT color="green">321</FONT>        }<a name="line.321"></a>
<FONT color="green">322</FONT>      }<a name="line.322"></a>
<FONT color="green">323</FONT>      <a name="line.323"></a>
<FONT color="green">324</FONT>      /**<a name="line.324"></a>
<FONT color="green">325</FONT>       * Returns the set of cache keys associated with this group.<a name="line.325"></a>
<FONT color="green">326</FONT>       * @param group The group.<a name="line.326"></a>
<FONT color="green">327</FONT>       * @return The set of cache keys for this group.<a name="line.327"></a>
<FONT color="green">328</FONT>       */<a name="line.328"></a>
<FONT color="green">329</FONT>      @SuppressWarnings("unchecked")<a name="line.329"></a>
<FONT color="green">330</FONT>      public Set&lt;K&gt; getGroupKeys(String group) {<a name="line.330"></a>
<FONT color="green">331</FONT>        Set&lt;K&gt; keySet;<a name="line.331"></a>
<FONT color="green">332</FONT>        try {<a name="line.332"></a>
<FONT color="green">333</FONT>          keySet = JCS.getInstance(this.cacheName).getGroupKeys(group);<a name="line.333"></a>
<FONT color="green">334</FONT>        }<a name="line.334"></a>
<FONT color="green">335</FONT>        catch (CacheException e) {<a name="line.335"></a>
<FONT color="green">336</FONT>          String msg = "Failure to obtain keyset for cache: " + this.cacheName;<a name="line.336"></a>
<FONT color="green">337</FONT>          log(msg);<a name="line.337"></a>
<FONT color="green">338</FONT>          keySet = new HashSet&lt;K&gt;();<a name="line.338"></a>
<FONT color="green">339</FONT>        }<a name="line.339"></a>
<FONT color="green">340</FONT>        return keySet;<a name="line.340"></a>
<FONT color="green">341</FONT>      }<a name="line.341"></a>
<FONT color="green">342</FONT>      <a name="line.342"></a>
<FONT color="green">343</FONT>      /**<a name="line.343"></a>
<FONT color="green">344</FONT>       * Returns the current number of elements in this cache group.<a name="line.344"></a>
<FONT color="green">345</FONT>       * @param group The name of the group.  <a name="line.345"></a>
<FONT color="green">346</FONT>       * @return The current size of this cache. <a name="line.346"></a>
<FONT color="green">347</FONT>       */<a name="line.347"></a>
<FONT color="green">348</FONT>      public int getGroupSize(String group) {<a name="line.348"></a>
<FONT color="green">349</FONT>        return getGroupKeys(group).size();<a name="line.349"></a>
<FONT color="green">350</FONT>      }<a name="line.350"></a>
<FONT color="green">351</FONT>     <a name="line.351"></a>
<FONT color="green">352</FONT>      /**<a name="line.352"></a>
<FONT color="green">353</FONT>       * Removes everything in the specified group.<a name="line.353"></a>
<FONT color="green">354</FONT>       * @param group The group name.  <a name="line.354"></a>
<FONT color="green">355</FONT>       */<a name="line.355"></a>
<FONT color="green">356</FONT>      public void clearGroup(String group) {<a name="line.356"></a>
<FONT color="green">357</FONT>        try {<a name="line.357"></a>
<FONT color="green">358</FONT>          JCS cache = JCS.getInstance(this.cacheName);<a name="line.358"></a>
<FONT color="green">359</FONT>          for (Object key : cache.getGroupKeys(group)) {<a name="line.359"></a>
<FONT color="green">360</FONT>            cache.remove(key, group);<a name="line.360"></a>
<FONT color="green">361</FONT>          }<a name="line.361"></a>
<FONT color="green">362</FONT>        }<a name="line.362"></a>
<FONT color="green">363</FONT>        catch (CacheException e) {<a name="line.363"></a>
<FONT color="green">364</FONT>          String msg = failureMsg + this.cacheName + ":" + e.getMessage();<a name="line.364"></a>
<FONT color="green">365</FONT>          log(msg);<a name="line.365"></a>
<FONT color="green">366</FONT>        }<a name="line.366"></a>
<FONT color="green">367</FONT>      }<a name="line.367"></a>
<FONT color="green">368</FONT>    <a name="line.368"></a>
<FONT color="green">369</FONT>      /**<a name="line.369"></a>
<FONT color="green">370</FONT>       * Sets up the Properties instance for configuring this JCS cache instance. Each SimpleJcs is<a name="line.370"></a>
<FONT color="green">371</FONT>       * defined as a JCS "region". Given a SimpleJcs named "PJ", we create a properties instance whose<a name="line.371"></a>
<FONT color="green">372</FONT>       * contents are similar to the following:<a name="line.372"></a>
<FONT color="green">373</FONT>       * <a name="line.373"></a>
<FONT color="green">374</FONT>       * &lt;pre&gt;<a name="line.374"></a>
<FONT color="green">375</FONT>       * jcs.region.PJ=DC-PJ<a name="line.375"></a>
<FONT color="green">376</FONT>       * jcs.region.PJ.cacheattributes=org.apache.jcs.engine.CompositeCacheAttributes<a name="line.376"></a>
<FONT color="green">377</FONT>       * jcs.region.PJ.cacheattributes.MaxObjects=[maxCacheCapacity]<a name="line.377"></a>
<FONT color="green">378</FONT>       * jcs.region.PJ.cacheattributes.MemoryCacheName=org.apache.jcs.engine.memory.lru.LRUMemoryCache<a name="line.378"></a>
<FONT color="green">379</FONT>       * jcs.region.PJ.cacheattributes.UseMemoryShrinker=true<a name="line.379"></a>
<FONT color="green">380</FONT>       * jcs.region.PJ.cacheattributes.MaxMemoryIdleTimeSeconds=3600<a name="line.380"></a>
<FONT color="green">381</FONT>       * jcs.region.PJ.cacheattributes.ShrinkerIntervalSeconds=3600<a name="line.381"></a>
<FONT color="green">382</FONT>       * jcs.region.PJ.cacheattributes.MaxSpoolPerRun=500<a name="line.382"></a>
<FONT color="green">383</FONT>       * jcs.region.PJ.elementattributes=org.apache.jcs.engine.ElementAttributes<a name="line.383"></a>
<FONT color="green">384</FONT>       * jcs.region.PJ.elementattributes.IsEternal=false<a name="line.384"></a>
<FONT color="green">385</FONT>       * jcs.region.PJ.elementattributes.MaxLifeSeconds=[maxIdleTime]<a name="line.385"></a>
<FONT color="green">386</FONT>       * jcs.auxiliary.DC-PJ=org.apache.jcs.auxiliary.disk.indexed.IndexedDiskCacheFactory<a name="line.386"></a>
<FONT color="green">387</FONT>       * jcs.auxiliary.DC-PJ.attributes=org.apache.jcs.auxiliary.disk.indexed.IndexedDiskCacheAttributes<a name="line.387"></a>
<FONT color="green">388</FONT>       * jcs.auxiliary.DC-PJ.attributes.DiskPath=[cachePath]<a name="line.388"></a>
<FONT color="green">389</FONT>       * jcs.auxiliary.DC-PJ.attributes.maxKeySize=10000000<a name="line.389"></a>
<FONT color="green">390</FONT>       * &lt;/pre&gt;<a name="line.390"></a>
<FONT color="green">391</FONT>       * <a name="line.391"></a>
<FONT color="green">392</FONT>       * See bottom of: http://jakarta.apache.org/jcs/BasicJCSConfiguration.html for more details.<a name="line.392"></a>
<FONT color="green">393</FONT>       * <a name="line.393"></a>
<FONT color="green">394</FONT>       * @param cacheName The name of this cache, used to define the region properties.<a name="line.394"></a>
<FONT color="green">395</FONT>       * @param dir The directory name, used to generate the disk storage directory.<a name="line.395"></a>
<FONT color="green">396</FONT>       * @param maxLifeSeconds The maximum life of instances in the cache in seconds before they expire.<a name="line.396"></a>
<FONT color="green">397</FONT>       * @param maxCapacity The maximum size of this cache.<a name="line.397"></a>
<FONT color="green">398</FONT>       * @return The properties file.<a name="line.398"></a>
<FONT color="green">399</FONT>       */<a name="line.399"></a>
<FONT color="green">400</FONT>      private Properties initJcsProps(String cacheName, String dir, Long maxLifeSeconds, <a name="line.400"></a>
<FONT color="green">401</FONT>          Long maxCapacity) {<a name="line.401"></a>
<FONT color="green">402</FONT>        String reg = "jcs.region." + cacheName;<a name="line.402"></a>
<FONT color="green">403</FONT>        String regCacheAtt = reg + ".cacheattributes";<a name="line.403"></a>
<FONT color="green">404</FONT>        String regEleAtt = reg + ".elementattributes";<a name="line.404"></a>
<FONT color="green">405</FONT>        String aux = "jcs.auxiliary.DC-" + cacheName;<a name="line.405"></a>
<FONT color="green">406</FONT>        String auxAtt = aux + ".attributes";<a name="line.406"></a>
<FONT color="green">407</FONT>        String memName = "org.apache.jcs.engine.memory.lru.LRUMemoryCache";<a name="line.407"></a>
<FONT color="green">408</FONT>        String diskAttName = "org.apache.jcs.auxiliary.disk.indexed.IndexedDiskCacheAttributes";<a name="line.408"></a>
<FONT color="green">409</FONT>        Properties props = new Properties();<a name="line.409"></a>
<FONT color="green">410</FONT>        props.setProperty("jcs.default", "DC");<a name="line.410"></a>
<FONT color="green">411</FONT>        //props.setProperty("jcs.default.cacheattributes.MaxObjects", maxCapacity.toString());<a name="line.411"></a>
<FONT color="green">412</FONT>        //props.setProperty("jcs.default.elementattributes.MaxLifeSeconds", maxLifeSeconds.toString());<a name="line.412"></a>
<FONT color="green">413</FONT>        <a name="line.413"></a>
<FONT color="green">414</FONT>        props.setProperty(reg, "DC-" + cacheName);<a name="line.414"></a>
<FONT color="green">415</FONT>        props.setProperty(regCacheAtt, "org.apache.jcs.engine.CompositeCacheAttributes");<a name="line.415"></a>
<FONT color="green">416</FONT>        props.setProperty(regCacheAtt + ".MaxObjects", maxCapacity.toString());<a name="line.416"></a>
<FONT color="green">417</FONT>        props.setProperty(regCacheAtt + ".MemoryCacheName", memName);<a name="line.417"></a>
<FONT color="green">418</FONT>        props.setProperty(regCacheAtt + ".UseMemoryShrinker", "true");<a name="line.418"></a>
<FONT color="green">419</FONT>        props.setProperty(regCacheAtt + ".MaxMemoryIdleTimeSeconds", "3600");<a name="line.419"></a>
<FONT color="green">420</FONT>        props.setProperty(regCacheAtt + ".ShrinkerIntervalSeconds", "3600");<a name="line.420"></a>
<FONT color="green">421</FONT>        props.setProperty(regCacheAtt + ".DiskUsagePatternName", "UPDATE");<a name="line.421"></a>
<FONT color="green">422</FONT>        props.setProperty(regCacheAtt + ".MaxSpoolPerRun", "500");<a name="line.422"></a>
<FONT color="green">423</FONT>        props.setProperty(regEleAtt, "org.apache.jcs.engine.ElementAttributes");<a name="line.423"></a>
<FONT color="green">424</FONT>        props.setProperty(regEleAtt + ".IsEternal", "false");<a name="line.424"></a>
<FONT color="green">425</FONT>        props.setProperty(regEleAtt + ".MaxLifeSeconds", maxLifeSeconds.toString());<a name="line.425"></a>
<FONT color="green">426</FONT>        props.setProperty(aux, "org.apache.jcs.auxiliary.disk.indexed.IndexedDiskCacheFactory");<a name="line.426"></a>
<FONT color="green">427</FONT>        props.setProperty(auxAtt, diskAttName);<a name="line.427"></a>
<FONT color="green">428</FONT>        props.setProperty(auxAtt + ".DiskPath", dir);<a name="line.428"></a>
<FONT color="green">429</FONT>        props.setProperty(auxAtt + ".maxKeySize", "1000000");<a name="line.429"></a>
<FONT color="green">430</FONT>        <a name="line.430"></a>
<FONT color="green">431</FONT>        echoProperties(props);<a name="line.431"></a>
<FONT color="green">432</FONT>        return props;<a name="line.432"></a>
<FONT color="green">433</FONT>      }<a name="line.433"></a>
<FONT color="green">434</FONT>      <a name="line.434"></a>
<FONT color="green">435</FONT>      /**<a name="line.435"></a>
<FONT color="green">436</FONT>       * Instantiates the directory indicated by dir, and throws an error if this is unsuccessful.<a name="line.436"></a>
<FONT color="green">437</FONT>       * <a name="line.437"></a>
<FONT color="green">438</FONT>       * @param dir The directory where the cache files will go.<a name="line.438"></a>
<FONT color="green">439</FONT>       */<a name="line.439"></a>
<FONT color="green">440</FONT>      private void mkdirs(String dir) {<a name="line.440"></a>
<FONT color="green">441</FONT>        File path = new File(dir);<a name="line.441"></a>
<FONT color="green">442</FONT>        boolean dirsOk = path.mkdirs();<a name="line.442"></a>
<FONT color="green">443</FONT>        if (!dirsOk &amp;&amp; !path.exists()) {<a name="line.443"></a>
<FONT color="green">444</FONT>          throw new RuntimeException("mkdirs() failed");<a name="line.444"></a>
<FONT color="green">445</FONT>        }<a name="line.445"></a>
<FONT color="green">446</FONT>      }<a name="line.446"></a>
<FONT color="green">447</FONT>      <a name="line.447"></a>
<FONT color="green">448</FONT>      /**<a name="line.448"></a>
<FONT color="green">449</FONT>       * Returns a string containing all current properties in alphabetical order.<a name="line.449"></a>
<FONT color="green">450</FONT>       * For debugging purposes. <a name="line.450"></a>
<FONT color="green">451</FONT>       * @param properties The properties of interest.<a name="line.451"></a>
<FONT color="green">452</FONT>       */<a name="line.452"></a>
<FONT color="green">453</FONT>      private void echoProperties(Properties properties) {<a name="line.453"></a>
<FONT color="green">454</FONT>        String cr = System.getProperty("line.separator"); <a name="line.454"></a>
<FONT color="green">455</FONT>        String eq = "=";<a name="line.455"></a>
<FONT color="green">456</FONT>        // Adding them to a treemap has the effect of alphabetizing them. <a name="line.456"></a>
<FONT color="green">457</FONT>        TreeMap&lt;String, String&gt; alphaProps = new TreeMap&lt;String, String&gt;();<a name="line.457"></a>
<FONT color="green">458</FONT>        for (Map.Entry&lt;Object, Object&gt; entry : properties.entrySet()) {<a name="line.458"></a>
<FONT color="green">459</FONT>          String propName = (String)entry.getKey();<a name="line.459"></a>
<FONT color="green">460</FONT>          String propValue = (String)entry.getValue();<a name="line.460"></a>
<FONT color="green">461</FONT>          alphaProps.put(propName, propValue);<a name="line.461"></a>
<FONT color="green">462</FONT>        }<a name="line.462"></a>
<FONT color="green">463</FONT>        StringBuffer buff = new StringBuffer(25);<a name="line.463"></a>
<FONT color="green">464</FONT>        for (String key : alphaProps.keySet()) {<a name="line.464"></a>
<FONT color="green">465</FONT>          buff.append(key).append(eq).append(properties.get(key)).append(cr);<a name="line.465"></a>
<FONT color="green">466</FONT>        }<a name="line.466"></a>
<FONT color="green">467</FONT>        // Now print the properties to a file. <a name="line.467"></a>
<FONT color="green">468</FONT>        BufferedWriter f;<a name="line.468"></a>
<FONT color="green">469</FONT>        try {<a name="line.469"></a>
<FONT color="green">470</FONT>          long timestamp = new Date().getTime();<a name="line.470"></a>
<FONT color="green">471</FONT>          f = new BufferedWriter(new FileWriter("jcs." + timestamp + ".properties"));<a name="line.471"></a>
<FONT color="green">472</FONT>          f.write(buff.toString());<a name="line.472"></a>
<FONT color="green">473</FONT>          f.close();<a name="line.473"></a>
<FONT color="green">474</FONT>        }<a name="line.474"></a>
<FONT color="green">475</FONT>        catch (Exception e) {<a name="line.475"></a>
<FONT color="green">476</FONT>          e.printStackTrace();<a name="line.476"></a>
<FONT color="green">477</FONT>        }<a name="line.477"></a>
<FONT color="green">478</FONT>      }<a name="line.478"></a>
<FONT color="green">479</FONT>    <a name="line.479"></a>
<FONT color="green">480</FONT>      /**<a name="line.480"></a>
<FONT color="green">481</FONT>       * Logs the message if a logger has been supplied.<a name="line.481"></a>
<FONT color="green">482</FONT>       * @param msg The msg to be logged, if there is a logger. <a name="line.482"></a>
<FONT color="green">483</FONT>       */<a name="line.483"></a>
<FONT color="green">484</FONT>      private void log(String msg) {<a name="line.484"></a>
<FONT color="green">485</FONT>        if (this.logger != null) {<a name="line.485"></a>
<FONT color="green">486</FONT>          this.logger.warning(msg);<a name="line.486"></a>
<FONT color="green">487</FONT>        }<a name="line.487"></a>
<FONT color="green">488</FONT>      }<a name="line.488"></a>
<FONT color="green">489</FONT>    }<a name="line.489"></a>




























































</PRE>
</BODY>
</HTML>
